Site Payments Process API - Implementation Template

Please review the prerequisite instructions to configure Veeva Vault CTMS and SAP.

Importing Templates into Anypoint Studio

1. In Studio, click the Exchange X icon in the upper left of the taskbar.
2. Log in with your Anypoint Platform credentials.
3. Search for the template.
4. Click Open.

Running Templates in Anypoint Studio

After you import your template into Studio, follow these configuration steps to run it.

Common Configuration

• mule.env - sets the environment where the application is to be deployed. It should be configured in config-<mule.env>.yaml file. For a studio deployment, the recommended mule.env value is local.
• mule.encryptionKey - sets the encryption password to be used for encrypting secure properties. Update as needed.

Please refer to the attached link on how to secure the configuration properties.

Site Payments Application Configuration

The application requires a few things to be configured, mainly the multiple system API connections information. Configure them in the properties file located in the config/properties folder.

• veeva-sys-api.host should be configured in config-<mule.env>.yaml file. URL for an instance of Veeva CTMS system API.
• veeva-sys-api.lifecycle-to-extracted-for-payment should be configured in config-<mule.env>.yaml file. Its a lifecycle state to change the payment request status from Ready for Payment to Extracted for Payment.
• veeva-sys-api.lifecycle-to-complete should be configured in config-<mule.env>.yaml file. Its a lifecycle state to change the payment request status from Extracted for Payment to Payment Completed.
• scheduler.veeva.frequency should be configured in config-<mule.env>.yaml file. Modify to match the schedule desired to process payment requests from Veeva Vault CTMS. Defaulted to once a day.
• scheduler.veeva.startDelay should be configured in config-<mule.env>.yaml file. Modify to the amount of time to wait before triggering the first time to process payment requests from Veeva Vault CTMS. Defaulted to next day.
• scheduler.sap.frequency should be configured in config-<mule.env>.yaml file. Modify to match the schedule desired to process cleared payments from SAP. Defaulted to once a day.
• scheduler.sap.startDelay should be configured in config-<mule.env>.yaml file. Modify to the amount of time to wait before triggering the first time to process cleared payments from SAP. Defaulted to next day.
• scheduler.sap.default-start-date should be configured in config-<mule.env>.yaml file. Modify to the desired date to fetch cleared payments from SAP.
• sap-sys-api.host should be configured in config-<mule.env>.yaml file. URL for your instance of target system api.
• sap-sys-api.journalEntry.senderSystemId should be configured in config-<mule.env>.yaml file.
• sap-sys-api.journalEntry.recipientSystemId should be configured in config-<mule.env>.yaml file.
• sap-sys-api.journalEntry.referenceDocumentType should be configured in config-<mule.env>.yaml file. Type of this business transaction document. Currently, the only allowed value in SAP is BKPFF (accounting document direct input).
• sap-sys-api.journalEntry.transactionType should be configured in config-<mule.env>.yaml file. It's a business transaction type that SAP supports.
• sap-sys-api.journalEntry.accountingDocumentType should be configured in config-<mule.env>.yaml file. It's document type of the accounting document.
• sap-sys-api.journalEntry.createdBy should be configured in config-<mule.env>.yaml file. It's a communication user in SAP.

Run the application

1. Right-click the template project folder.
2. Hover your mouse over 'Run as'.
3. Click Mule Application (configure).
4. Inside the dialog, select Environment and set the variable mule.env to the appropriate value (dev or local).
5. Inside the dialog, select Environment and set the variable encryptionKey to the property encryption key that you used to encrypt your secure properties.
6. Click Run.

Deployment instructions for CloudHub using provided scripts

Ensure the Maven profile CloudHub-HLS-DEV has been properly configured in your settings.xml file. Reference can be found by downloading the Accelerator Common Resources asset. Additional instructions are available in the Getting Started with MuleSoft Accelerators - Build Environment guide.

Update the config-<env>.yaml properties appropriately and then use one of the following scripts to deploy the application to CloudHub:

• packageDeploy.sh (Mac/Linux).
• packageDeploy.cmd (Windows).